Fzzy Config/me.fzzyhmstrs.fzzy_config.config/ConfigAction

ConfigAction

class ConfigAction @JvmOverloads constructor(titleSupplier: Supplier<Text>, activeSupplier: Supplier<Boolean>, pressAction: Runnable, decoration: Decorated?, description: Text? = null, background: TextureProvider? = null) : EntryWidget<Any> , EntryFlag, EntryCreator, EntryTransient, TranslatableEntry

Builds a button that will appear in a Config GUI, to perform some arbitrary, possible non-config-related action

This could be used to link to a wiki, open another non-fzzy-config config, open a non-config screen, open a patchouli guide, run a command, and so on.

See the Wiki for more details and examples.

Author

fzzyhmstrs

Since

0.5.0, Decorated and TextureSet incorporated 0.6.0

Parameters

titleSupplier

Supplier - supplies a name for the button widget. Will be checked every frame, so the button name will dynamically update as needed.

activeSupplier

Supplier - supplies an active state; whether the button is inactive ("greyed out" and unclickable) or active (functioning normally)

pressAction

Runnable - the action to execute on clicking the button

background

Identifier, nullable - if non-null, will provide a custom background for the widget rendering.

decoration

Decorated, nullable - if non-null, will render a "decoration" next to the widget. These are the typically white/wireframe icons shown next to certain settings like lists.

Constructors

ConfigAction

constructor(titleSupplier: Supplier<Text>, activeSupplier: Supplier<Boolean>, pressAction: Runnable, decoration: Identifier?, description: Text? = null, background: Identifier? = null)

@JvmOverloads

constructor(titleSupplier: Supplier<Text>, activeSupplier: Supplier<Boolean>, pressAction: Runnable, decoration: Decorated?, description: Text? = null, background: TextureProvider? = null)

Types

Builder

class Builder

Builds a ConfigAction

Companion

object Companion

Functions

descriptionKey

open override fun descriptionKey(): String

translation key of this Translatable description. the "description" in-game, the descriptions Enchantment Descriptions adds to enchantment tooltips are a good example.

descriptionOrNull

open fun descriptionOrNull(fallback: String? = null): MutableText?

The translated Text description from the descriptionKey. Falls back to an empty string so no tooltip is rendered. If no translation exists when called returns null.

flags

open fun flags(): Byte

getEntryKey

open override fun getEntryKey(): String

hasPrefix

open fun hasPrefix(): Boolean

Whether this Translatable has a valid prefix

hasTranslation

open fun hasTranslation(): Boolean

Whether this Translatable has a valid translation

prefix

open override fun prefix(fallback: String?): MutableText

The translated Text description from the descriptionKey. Falls back to an empty string so no tooltip is rendered.

prefixKey

open override fun prefixKey(): String

translation key of this Translatable inline prefix text. Unlike descriptions, which are usually displayed in-tooltips, prefixes are displayed inline in the config screen itself

prefixOrNull

open fun prefixOrNull(fallback: String? = null): MutableText?

The translated Text description from the descriptionKey. Falls back to an empty string so no tooltip is rendered. If no translation exists when called returns null.

prepare

open fun prepare(scope: String, groups: LinkedList<String>, annotations: List<Annotation>, globalAnnotations: List<Annotation>)

Called in the prepare stage of screen building to perform any necessary pre-entry-creation tasks.

setEntryKey

open override fun setEntryKey(key: String)

translation

open override fun translation(fallback: String?): MutableText

The translated Text name from the translationKey. Falls back to the implementing classes Simple Name (non-translated)

translationKey

open override fun translationKey(): String

translation key of this Translatable. the "name" in-game

translationOrNull

open fun translationOrNull(fallback: String? = null): MutableText?

The translated Text name from the translationKey. Falls back to the implementing classes Simple Name (non-translated). If no translation exists when called returns null.

widgetAndTooltipEntry

open fun widgetAndTooltipEntry(choicePredicate: ChoiceValidator<Any> = ChoiceValidator.any()): ClickableWidget

Builds a new ClickableWidget and applies a tooltip to it. This shouldn't need to be overridden in most cases